Request For Payment Cancellation

The RequestForPaymentCancellation method enables to receive 'RFP Cancellation Request' initiated by the beneficiary for the RFP Request

Method: InboundServiceClient:RequestForPaymentCancellation

Headers

Name	Value
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
caseData Mandatory	Object
emailAddress Mandatory	String Email of the case handler who checks this request Example – "ramesh@test.com"
Id Mandatory	String Unique ID of the case handler who checks this request Example – "CASEFEDRFP20240603001"
name Mandatory	String Name of the case handler who checks this request Example – "Ramesh P"
phoneNumber Mandatory	String Contact phone number of the case handler who checks this request Example – "+1-5632897456"
preferredMethod Mandatory	String Preferable mode of contacting the case handler Example – "PHON"
creditorAccount Mandatory	Object
memberId Mandatory	String Routing numer of the beneficiary bank/financial institution Example – "101110802"
debtorAccount Mandatory	Object
memberId Mandatory	String Routing numer of the sender bank/financial institution Example – "101115315"
msgID Mandatory	String Unique message identifier to identify the pacs.008 message Example – "20240603101110802A75u01MhRvWhdgR"
orgMessageInfo Mandatory	Object
createdDateTime Mandatory	String Date and time of the original RFP message was created Example – "2024-06-03T09:14:36Z"
endToEndId Mandatory	String ID that enables to trace the original message at any time during the process Example – "20240603101110802a7GGSvzGuSJNHZG"
msgId Mandatory	String Unique message identifier to identify the original message Example – "20240603101110802a7GGSvzGuSJNHZG"
msgNmId Mandatory	String Unique ID of the message name that indicates the type of message Example – "20240531101110802HlHiR6JQO50N4ZO"
requestedAmount Mandatory	Object
Amount Mandatory	Number Amount of transaction requested in original message Example – 650
Currency Mandatory	String Currency code in which the original transaction was requested Example – "USD"
processor Mandatory	String Payment channel through which the transaction happens Example – "FEDNOW"
reason Mandatory
additionalInfo Mandatory	String Reason for cancelling the payment request Example – "Invalid creditor"
code Mandatory	String Reason code of the given reason Example – "AC03"
referenceNumber Mandatory	String Reference number of the Request for Payment cancellation request Example – "20240603101110802a7GGSvzGuSJNHZG"
uuid Mandatory	String Unique ID present in the message Example – "fbae0a40-e605-40a5-85ef-b99ae92b06da"

Request Body (Applicable only for FedNow)

{
  "caseData": {
    "emailAddress": "ramesh@test.com",
    "id": "CASEFEDRFP20240603001",
    "name": "Ramesh P",
    "phoneNumber": "+1-5632897456",
    "preferredMethod": "PHON"
  },
  "creditorAccount": {
    "memberId": "101110802"
  },
  "debtorAccount": {
    "memberId": "101115315"
  },
  "msgID": "20240603101110802A75u01MhRvWhdgR",
  "orgMessageInfo": {
    "createdDateTime": "2024-06-03T09:14:36Z",
    "endToEndId": "20240603101110802a7GGSvzGuSJNHZG",
    "msgId": "20240603101110802a7GGSvzGuSJNHZG",
    "msgNmId": "pain.013.001.07",
    "requestedAmount": {
      "amount": 650,
      "currency": "USD"
    }
  },
  "processor": "FEDNOW",
  "reason": {
    "additionalInfo": "Invalid creditor",
    "code": "AC03"
  },
  "referenceNumber": "20240603101110802a7GGSvzGuSJNHZG",
  "uuid": "58a80b3d-0987-42a0-909c-ff746336f1a2"
}

Response

Response Parameters

Parameter	Description
referenceNumber	String Reference number of the Payment cancellation request Example – "20240603101110802a7GGSvzGuSJNHZG"
status	String Status of the response Example – "Cancelation Request Received"

Response Body (Applicable only for FedNow)

{
  "referenceNumber": "20240603101110802a7GGSvzGuSJNHZG",
  "status": "Cancelation Request Received"
}